Get API key details by code and API key

GET /api/v1/tenants/:tenantId/codes/:code/apikey/:apikey

Description

Get API key details by code and API key.

Request

• Authentication:
  • Type: Bearer Token
  • Token: {{bearerToken}} (Replace with the actual bearer token)
• URL:
  • Raw URL: /api/v1/tenants/:tenantId/codes/:code/apikey/:apikey?allowDelay=1
  • Host:
  • Path: /api/v1/tenants/:tenantId/codes/:code/apikey/:apikey
  • Query Parameter:
    • allowDelay: 1 (Delay allowed by default, set to 0 or false to turn off delay)

Response:

• Status: OK (200)

/api/v1/tenants/:tenantId/codes/:code/apikey/:apikey?allowDelay=1

Query Params

Param	value
allowDelay	1

🔑 Authentication bearer

Param	value	Type
token	bearerToken	string

Response: 200

{
  "_id": "67a81174ad6533e2adb2d03c",
  "allowEncoding": false,
  "apiKey": "f55368a7-50b6-4d64-9390-7dfdbb3171f0",
  "apiCode": "intranet",
  "type": "TENANT_SERVICE",
  "status": "ACTIVE",
  "expiryPeriod": "2025-05-20T23:59:59.999Z",
  "tenant": {
    "kycDetails": {
      "businessDetails": {
        "metadata": {
          "isBusinessDeliveryPerformance": false,
          "isKickBackPromised": false,
          "isCompanyRegulated": false,
          "isSharesListed": false,
          "isCompanySubjectToInvestigation": false,
          "isShareholderPoliticallyExposed": false
        },
        "isProofOfBusinessAddressVerified": "PENDING",
        "isTaxIdentificationNumberVerified": "PENDING",
        "isIncorporationNumberVerified": "PENDING",
        "isCacStatusReportVerified": "PENDING",
        "isProofOfBankAccountVerified": "PENDING",
        "isProofOfBankStatementVerified": "PENDING",
        "isProofOfVatCertificateVerified": "PENDING",
        "isCertificateOfIncorporationVerified": "PENDING",
        "isArticlesOfAssociationVerified": "PENDING",
        "directorsProofOfAddress": [],
        "isDirectorsProofOfAddressVerified": "PENDING",
        "shareHoldersProofOfAddress": [],
        "isShareHoldersProofOfAddressVerified": "PENDING",
        "directorsProofOfIdentification": []
      },
      "status": "PENDING",
      "additionalShareholdersDetails": [],
      "guarantorDetails": []
    },
    "wallet": {
      "virtualBankCode": "035",
      "virtualBankName": "Wema Bank",
      "createdAt": null,
      "accounts": []
    },
    "config": {
      "walletSettings": {
        "allowUserSettlementAccountUpdate": false
      },
      "logisticDeliverySetting": {
        "isProviderSplitEnabled": false,
        "isDropOffCodeEnabled": false,
        "defaultProvider": "FLEET",
        "deliveryFeeType": "RATECARD",
        "providerSplits": []
      },
      "merchantSetting": {
        "priceMargin": {
          "type": "PERCENT",
          "value": 0,
          "enabled": false,
          "capped": 0
        },
        "commission": {
          "type": "PERCENT",
          "value": 0,
          "enabled": false,
          "capped": 0
        },
        "enableGlobalPriceMargin": true,
        "enableGlobalCommissionMargin": false,
        "orderNotificationsEnabledForTenantOwner": false,
        "isMovEnabled": false,
        "movPatternType": "CUSTOMER",
        "returnRecipientType": "TENANT"
      },
      "deviceSettings": {
        "isAllowMultipleDevice": false,
        "maxDevicesAllowed": 1,
        "idleLogoutEnabled": false,
        "autoSignOutLeastActiveDevice": true
      },
      "passwordSettings": {
        "isPasswordExpirationEnabled": false,
        "passwordExpirationValue": 3,
        "passwordExpirationPeriod": "MONTHS",
        "isPasswordHistoryCheckEnabled": false,
        "passwordHistoryLimit": 5,
        "isPasswordComplexityCheckEnabled": true,
        "passwordMinLength": 8,
        "passwordRequiresUppercase": true,
        "passwordRequiresLowercase": true,
        "passwordRequiresNumbers": true,
        "passwordRequiresSpecialCharacters": true,
        "invitationPasswordResetType": "NOT_REQUIRED"
      },
      "notificationSettings": {
        "isInAppNotificationEnabled": true,
        "isSmsNotificationEnabled": true,
        "isPushNotificationEnabled": true,
        "isEmailNotificationEnabled": true
      },
      "reviewSettings": {
        "permissionMode": "TENANT",
        "stateMode": "ACTIVE"
      },
      "isBusinessNameFormatted": false,
      "isProductNameFormatted": false,
      "isUniqueBusiness": false,
      "isUniqueUser": false,
      "isEnforceKYBErrorOnFailedVerification": false,
      "isOutOfStockVisible": false,
      "isAllowProductVisibleOnCreate": false,
      "isAllowLogisticEnabledOnOrder": false,
      "isAllowLogisticOnDistributorOrder": false,
      "isAllowLogisticOnManufacturerOrder": false,
      "isAllowLogisticOnWholesalerOrder": true,
      "isAllowPickupAddressSentOnOrder": false,
      "isWholesalerDisableOnCreate": false,
      "isDistributorDisableOnCreate": false,
      "isManufacturerDisableOnCreate": false,
      "isEnableLocalWallet": false,
      "isEnableWalletPaymentForDistributor": false,
      "isEnableWalletPaymentForManufacturer": false,
      "isEnableWalletPaymentForWholesaler": true,
      "enableOtpValidationForSettlementAccount": false,
      "merchantInventorySettlementStatus": "DELIVERED",
      "merchantInventorySettlementLienEnable": false,
      "merchantInventorySettlementLienDuration": 0,
      "merchantInventorySettlementLienPercent": 100,
      "wholesalerDefaultLocationRadius": 40,
      "distributorDefaultLocationRadius": 40,
      "manufacturerDefaultLocationRadius": 40,
      "isEmailVerificationRequired": false,
      "quad": "QUAD_1"
    },
    "settlement": {
      "enableAutoSettlement": false
    },
    "_id": "67a8070cad6533e2adb2cc6f",
    "code": "3f8f94dd-29a6-4c3e-aab4-984606a960b5",
    "name": "Aryanna",
    "tenantHandle": "twilamurray43",
    "phone": "2348069887437",
    "ipAddresses": [],
    "domains": [],
    "country": {
      "name": "Nigeria",
      "code": "NG",
      "currency": "NGN",
      "_id": "67a7c352a9a55da218c20abe"
    },
    "user": "67a7c352a500fdac931338bf",
    "deleted": false,
    "rotationPeriod": "DAYS",
    "rotationValue": 100,
    "createdBy": "67a7c352a500fdac931338bf",
    "services": [
      {
        "keyManager": "67a81174ad6533e2adb2d03c",
        "service": "67a807b4a500fdac939a1e7c",
        "config": {
          "ylabel": "string",
          "thslabel": "string"
        },
        "_id": "67a81174ad6533e2adb2d043"
      }
    ],
    "products": [],
    "createdAt": "2025-02-09T01:38:20.654Z",
    "updatedAt": "2025-02-09T02:22:44.777Z",
    "callBackUrl": "www.google.com"
  },
  "service": {
    "_id": "67a807b4a500fdac939a1e7c",
    "code": "intranet",
    "config": [
      {
        "label": "luka Label",
        "key": "ylabel",
        "required": true,
        "value": "string",
        "valueType": "string",
        "formType": "input"
      },
      {
        "label": "Laka label",
        "key": "thslabel",
        "required": true,
        "value": "string",
        "valueType": "string",
        "formType": "input"
      }
    ],
    "createdAt": "2025-02-09T01:41:08.828Z",
    "name": "Intranet",
    "overview": "Care",
    "requirements": ["HAVE 1", "HAVE 2"],
    "rotationPeriod": "HOURS",
    "rotationValue": 6285,
    "urlIdentity": "https://orpha.org"
  },
  "reminderEmailSent": 2,
  "deleted": false,
  "createdAt": "2025-02-09T02:22:44.047Z",
  "updatedAt": "2025-02-09T02:24:33.683Z",
  "publicCode": "-----BEGIN PUBLIC KEY----- MIICITAN..."
}